<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" Content="text/html; charset=Windows-1252">
<TITLE>HH_AKLINK structure</TITLE>
<style>@import url(coUA.css);</style>
<link disabled rel="stylesheet" href="htmlhelp.css">
</head>

<BODY>

<H1>HH_AKLINK structure</H1>
<p>Use this structure to specify one or more ALink names or KLink keywords that you want to search for.</p>

<p>If the lookup yields no matching topics, HtmlHelp() checks the values of the following <b>HH_AKLINK</b> members to determine what alternative action to take:

<ul>
<li><i>fIndexOnFail</i>. If <i>fIndexOnFail</i> is TRUE, the <b>Index</b> tab is selected in the help window specified in <i>pszWindow</i>, and the keyword specified in <i>pszKeyword</i> is selected in the entry field.

<li><i>pszURL</i>. If <i>fIndexOnFail</i> is FALSE, the topic file specified in <i>pszURL</i> appears in the help window specified in <i>pszWindow</i>.

<li><i>pszMsgText</i> and <i>pszMsgTitle</i>. If <i>fIndexOnFail</i> is FALSE and <i>pszURL</i> is NULL, a message box appears using the text and caption specified in  
<i>pszMsgText</i> and <i>pszMsgTitle</i>.
</ul>

<h2>Used by</h2>
<ul>
<li><a href="cmd_hh_alink_lookup.htm">HH_ALINK_LOOKUP</a>
<li><a href="cmd_hh_keyword_lookup.htm">HH_KEYWORD_LOOKUP</a> 
</li>
</ul>

<h2>HH_AKLINK structure syntax</h2>
<p><PRE><code>
typedef struct tagHH_AKLINK
<br>{
<br>     int      cbStruct;      
<br>     BOOL     fReserved;
<br>     LPCTSTR  pszKeywords;      
<br>     LPCTSTR  pszUrl;       
<br>     LPCTSTR  pszMsgText;            
<br>     LPCTSTR  pszMsgTitle; 
<br>     LPCTSTR  pszWindow; 
<br>     BOOL     fIndexOnFail;     
<br>} HH_AKLINK;
</p></PRE></code>

<br>
<table border=1 cellpadding=3 cellspacing=0 width=100%>
<TR>
<TH><b>Member</b>
</TH>
<TH><b>Description</b>
</TH>
</TR>

<TR>
<TD><i>cbStruct</i>
</TD>
<TD>Specifies the size of the structure. This value must always be filled in before passing the structure to the HTML Help API.
</TD>
</TR>

<TR>
<TD><i>fReserved</i>
</TD>
<TD>This parameter must be set to FALSE.
</TD>
</TR>

<TR>
<TD><i>pszKeywords</i>
</TD>
<TD>Specifies one or more ALink names or KLink keywords to look up. Multiple entries are delimited by a semicolon.
</TD>
</TR>

<TR>
<TD><i>pszUrl</i>
</TD>
<TD>Specifies the topic file to navigate to if the lookup fails. <i>pszURL</i> refers to a <a href="ov_about_html_help_urls.htm">valid topic</a> within the specified compiled help (.chm) file and does not support Internet protocols that point to an HTML file.
</TD>
</TR>

<TR>
<TD><i>pszMsgText</i>
</TD>
<TD>Specifies the text to display in a message box if the lookup fails and <i>fIndexOnFail</i> is FALSE and <i>pszURL</i> is NULL.
</TD>
</TR>

<TR>
<TD><i>pszMsgTitle</i>
</TD>
<TD>Specifies the caption of the message box in which the <i>pszMsgText</i> parameter appears.
</TD>
</TR>

<TR>
<TD><i>pszWindow</i>
</TD>
<TD>Specifies the name of the window type in which to display one of the following:
<ul>
<li>The selected topic, if the lookup yields one or more matching topics.</li>
<li>The topic specified in <i>pszURL</i>, if the lookup fails and a topic is specified in <i>pszURL</i>.</li>
<li>The <b>Index</b> tab, if the lookup fails and <i>fIndexOnFail</i> is specified as TRUE.</li>
</ul>
</TD>
</TR>

<TR>
<TD><i>fIndexOnFail</i>
</TD>
<TD>Specifies whether to display the keyword in the <b>Index</b> tab of the HTML Help Viewer if the lookup fails. The value of <i>pszWindow</i> specifies the Help Viewer.
</TD>
</TR>
</table>

<H2>Comments</H2>
<ul>
<li>ALink name and KLink keyword lookups are case sensitive, and multiple keywords are delimited by a semicolon.</li>
<li>If the lookup yields one or more matching topics, the topic titles appear in the <b>Topics Found</b> dialog box.</li>
</ul>


<br>
<table border="0" cellpadding="0" cellspacing="4">
<tr>
<td valign="top"><a href="ov_about_htmlhelp_structures.htm"><img src="home.gif" width=20 height=18 alt="link to overview topic" border="0"></a>
</td>
<td><a href="ov_about_htmlhelp_structures.htm">About structures</A>
</td>
</tr>
<tr>
<td>&nbsp;
</td>
</tr>
</table>

<br>


</BODY>
</HTML>
